Eplan Platform API
Eplan API / API Reference / Actions
In This Topic
    Actions
    In This Topic

    This is the list of all official Eplan API actions available for the user

    Name Description
    backup
    
    Action class for backup functions. Backs up a project and master data (forms, symbols, ...) to disk
    changelayer
    
    Changes graphical layer properties.
    check
    
    Action class for checking functions: check a project and check pages.
    CleanWorkspaceAction
    
    Cleans an existing workspace.
    compress
    
    Action class to compress projects.
    devicelist
    
    Action class for device list functions: import, export, and delete device lists.
    edit
    
    Action class for edit functions: Opens a project, opens a specific page (identified by the page name), opens a page with a specific device (identified by the device name) or opens a specific page (identified by the page name) and sets the cursor at the X and Y coordinates.
    EplApiModuleAction
    
    Loads and registers an API add-in for .NET Framework based code.
    EplApiModuleActionNet
    
    Loads and registers an API add-in for .NET Core based code.
    EsCorrectConnections
    
    Merges graphical properties (color, line type, layer...) of connection definition points into one signal definition point for each signal, if these graphical properties are equal on the whole signal.
    ExecuteScript
    
    Runs the given script.
    export
    
    Action to export pages and projects in graphical, DXF, DWG, PXF format.
    export3d
    
    Action to export installation spaces into 3D formats.
    ExportNCData
    
    Action exports NC data for machines.
    ExportProductionWiring
    
    Action to export Production Wiring Data for machines according to calling parameters.
    ExportSegmentsTemplate
    
    Action to export segment templates to file.
    exportToGraphics
    
    Action to export pages and projects to graphical (TIF, GIF, PNG, JPG) format.
    gedRedraw
    
    Action class for GED redraw.
    generate
    
    Action class for generate functions: generate connections and generate cables.
    generatemacros
    
    Action for generating macros from project.
    graphicallayertable
    
    Action class for graphical layer table functions: import, export.
    import
    
    Action for importing projects, macros, and drawings.
    import3d
    
    Action for importing 3d data.
    ImportPrePlanningData
    
    Action to import pre-planning data.
    ImportSegmentsTemplate
    
    Action to import segment templates from file to project.
    InsertModelViewAction
    
    Action to insert model view object on a page.
    label
    
    Action class to create labels for projects.
    masterdata
    
    Action class for operations related to EPLAN master data.
    MfExportRibbonBarAction
    
    Exports main ribbon bar customizing to XML file.
    MfImportRibbonBarAction
    
    Imports main ribbon bar customizing from XML file.
    navigateToEEC
    
    Action class to navigate to an object in the EPLAN Engineering Configuration.
    OpenWorkspaceAction
    
    Opens an existing workspace.
    partslist
    
    Action class for exporting and importing parts and other parts management items like addresses, constructions, terminals, accessory lists and accessory placements. Allows also to delete stored properties.
    partsmanagementapi
    
    Action class for exporting and importing parts and other parts management items like addresses, constructions, terminals, accessory lists and accessory placements.
    plcservice
    
    Exports/imports PLC data using the specified converter.
    preparemacros
    
    Action for preparing project for macro generation.
    print
    
    Action class to print projects and pages.
    ProjectAction
    
    Runs an action upon a given project and closes project afterwards.
    projectmanagement
    
    Action class for project management.
    ProjectOpen
    
    Opens given project.
    RegisterCustomPropertyEditorAction
    
    Registers/Unregisters a custom editor dialog for a property ID or identifying name of a user-defined property.
    RegisterScript
    
    Register a script.
    renumber
    
    Action corresponds to numbering functionality.
    reports
    
    Action class to update all project evaluations.
    restore
    
    Action class for restore functions: restore projects and restore master data (forms, symbols, ...)
    SaveWorkspaceAction
    
    Saves the specified workspace. If the workspace already exists, changes are saved. If the workspace does not yet exist, it is created and saved.
    search
    
    Action class for search operations. Searches items in a project.
    selectionset
    
    Action class for selection set functions: get current project, get selected projects, get selected pages.
    SetProjectLanguage
    
    Sets project languages for read-write and read-only projects.
    subprojects
    
    Action class to export and import subprojects.
    SwitchProjectType
    
    Action to change type of project.
    synchronize
    
    Action class to synchronize project data.
    Topology
    
    Action for topology-related operations.
    translate
    
    Action class for translate functions: translate a project, export missing translation list, and remove languages from a project.
    UnregisterScript
    
    Unregisters a script.
    UpdateSegmentsFilling
    
    Calculates and sets value of property CABLINGSEGMENT_FILLING for all segments in project.
    XAfActionSetting
    
    Sets the value of a setting.
    XAfActionSettingProject
    
    Sets the value of a project setting.
    XAMlExportProductionData2RASCenterAction
    
    Export of the construction spaces of the selected project in AutomationML format. The generated AutomationML file is intended for import into the Rittal - RiPanel Processing Center, which controls the machines for creating the openings or cutting the mounting rails and wiring channels.
    XAMlExportProductionData2SmartMountingAction
    
    Export of the construction spaces of the selected project in AutomationML format. The generated AutomationML file is intended for import into the Rittal - RiPanel Processing Center, which controls the machines for creating the openings or cutting the mounting rails and wiring channels.
    XCabCalculateEnclosureTotalWeightAction
    
    Calculates the total weight of a cabinet and writes it to the "Total weight" property (#36108 - FUNCTION3D_CABINET_TOTALWEIGHT)
    XCCreateGravingtextAction
    
    Generates an engraving text from the DTs of the source and target of the cable. By default, the designation is abbreviated in accordance with the VASS standard (Volkswagen Audi Seat Skoda), i.e., structure identifiers having the same name of source and target are removed - starting from the left.
    XCMRemoveUnnecessaryNDPsAction
    
    Removes unnecessary net definition points of active project.
    XCMUniteNetDefinitionPointsAction
    
    Unites net definition points placed on the same net in active project.
    XDLInsertDeviceAction
    
    Starts interaction for inserting a device.
    XEGActionInsertSymRef
    
    Standard action to find symbol references for inserting.
    XEsGetPagePropertyAction
    
    Gets a special property of first selected page.
    XEsGetProjectPropertyAction
    
    Gets a special property of the current project.
    XEsGetPropertyAction
    
    Gets selected objects and gets the property.
    XEsSetPagePropertyAction
    
    Sets a special property of selected pages.
    XEsSetProjectPropertyAction
    
    Sets a special property of a current project.
    XEsSetPropertyAction
    
    Gets selected objects and sets the property.
    XEsUserPropertiesExportAction
    
    Exports user properties from project to file.
    XEsUserPropertiesImportAction
    
    Imports user properties to project from file.
    XGedClosePage
    
    Closes all selected pages.
    XGedStartInteractionAction
    
    Starts an interaction of the graphical editor.
    XGedUpdateMacroAction
    
    Updates macros. It can be passed the full path of a project. When project is not opened, this action opens it and closes it automatically.
    XMActionDCCommonExport
    
    Starts the export for the external editing.
    XMActionDCImport
    
    Imports a data configuration file into an existing EPLAN project.
    XMDeleteReprTypeAction
    
    Removes a representation type from selected macros and what is stored in a selected directory.
    XMExportConnectionsAction
    
    Action class to export connections of a project.
    XMExportDCArticleDataAction
    
    Starts the export for the external editing.
    XMExportFunctionAction
    
    Action class to export functions of a project.
    XMExportLocationBoxesAction
    
    Action class to export location boxes of a project.
    XMExportPagesAction
    
    Action class to export pages of a project.
    XMExportPipeLineDefsAction
    
    Action class to export pipeline definitions of a project.
    XMExportPotentialDefsAction
    
    Action class to export potential definitions of a project.
    XMImportDCArticleDataAction
    
    Imports a data configuration file into an existing EPLAN article database.
    XPamsDeviceSelectionAction
    
    Selects device or updates device information. This object can be a project/function/connection.
    XPamSelectPart
    
    Starts the part selection (using the configured database).
    XPartsSetDataSourceAction
    
    Changes the setting responsible for parts management database type.
    XPlaUpdateDetailAction
    
    The detail engineering is updated for the selected planning objects
    XPrjActionUpgradeProjects
    
    This action upgrades one ore more projects to the actual database scheme version.
    XPrjConvertBaseProjectsAction
    
    This action converts one ore more old basic projects (*.ept and *.epb files) to new basic projects (*.zw9). All basic projects in a folder are upgraded (recursively).
    XSDPreviewAction
    
    Opens or closes the preview of a project page or macro
    XSettingsExport
    
    Exports settings to an XML file.
    XSettingsImport
    
    Imports project-, station-, company- or user settings from an XML file.
    XSettingsRegisterAction
    
    Registers Add-ons.
    XSettingsUnregisterAction
    
    Unregistration of Add-ons.